🛠️ Guia de Contribuição
Para manter a organização e a qualidade do código, siga estas diretrizes.
✅ Commits
Utilizamos o padrão Conventional Commits.
Formato:
Tipos válidos:
feat
: nova funcionalidadefix
: correção de bugsdocs
: documentaçãostyle
: formatação e estilo (sem alteração de código)refactor
: refatoração sem mudança de comportamentoperf
: melhoria de performancetest
: testes adicionados ou atualizadosbuild
: mudanças que afetam o processo de build ou dependênciasci
: configuração de integração contínuachore
: tarefas administrativas ou manutençãorevert
: desfaz alterações anteriores
Exemplo:
🌱 Nome de branch
Use o padrão:
Exemplos:
feat/cadastro-usuario
fix/erro-listagem-produtos
docs/adiciona-readme
refactor/reorganiza-componentes
🚀 Pull Request
Antes de abrir um PR, verifique:
- [ ] A branch está atualizada com a `main` ou `develop`
- [ ] Os commits seguem o padrão
- [ ] O código foi testado localmente
- [ ] A documentação (se aplicável) foi atualizada
- [ ] Nenhum arquivo sensível ou desnecessário foi incluído
📝 Título do PR
Mesmo padrão do commit:
Exemplo:
💬 Corpo do PR
Inclua: - O que foi feito - Por que foi feito - Como testar - Pendências (se houver) - Screenshot ou vídeo (se aplicável)
🔁 Exemplo completo
-
Nome da branch:
-
Commits:
-
Título do Pull Request:
-
Corpo do Pull Request:
## O que foi feito - Página de login com campos de email e senha - Integração com backend usando JWT - Armazenamento do token no localStorage ## Por que Esta funcionalidade é necessária para autenticar usuários e proteger rotas privadas. ## Como testar - Rodar o backend local - Acessar `/login` no frontend - Inserir credenciais válidas - Verificar se o token é salvo e se redireciona para `/dashboard` ## Pendências - Testes automatizados ainda não implementados
💬 Dúvidas?
Abra uma issue ou entre em contato com um dos mantenedores do projeto.
Histórico de versão
Data | Versão | Descrição | Autor |
---|---|---|---|
21/05/25 | 1.0 | Adiciona documento de política de contribuição ao git pages | Sophia e Christopher |